// Go作者版权所有。版权所有。
// 此源代码的使用受BSD样式的约束
// 可以在许可证文件中找到的许可证。

// 包导入器直接实现导入
// 来自源文件而不是已安装的软件包。
package srcimporter // 导入“go/internal/srcimporter”

import (
	"fmt"
	"go/ast"
	"go/build"
	"go/parser"
	"go/token"
	"go/types"
	exec "internal/execabs"
	"io"
	"os"
	"path/filepath"
	"strings"
	"sync"
	_ "unsafe" // 适用于go:linkname
)

// 导入器提供从源代码导入包的上下文。
type Importer struct {
	ctxt     *build.Context
	fset     *token.FileSet
	sizes    types.Sizes
	packages map[string]*types.Package
}

// New返回给定上下文、文件集和映射的新导入器
// 包裹的数量。上下文用于将导入路径解析为包路径，
// 以及识别属于该包的文件。如果上下文提供
// 非nil文件系统函数，它们用于替代常规包
// 操作系统功能。文件集用于跟踪包的位置信息
// 文件夹；导入的包将添加到包映射中。
func New(ctxt *build.Context, fset *token.FileSet, packages map[string]*types.Package) *Importer {
	return &Importer{
		ctxt:     ctxt,
		fset:     fset,
		sizes:    types.SizesFor(ctxt.Compiler, ctxt.GOARCH), // 如果找不到GOARCH，则使用go/types默认值
		packages: packages,
	}
}

// 导入是在Importer.packages中占据一席之地的哨兵
// 对于正在导入的包。
var importing types.Package

// 导入（路径）是导入自（路径“.”，0）的快捷方式。
func (p *Importer) Import(path string) (*types.Package, error) {
	return p.ImportFrom(path, ".", 0) // 使用“.”而不是“.”（见第24441期）
}

// ImportFrom使用从给定srcDir解析的给定导入路径导入包，
// 将新包添加到导入程序维护的包集中，并返回
// 包裹包路径解析和文件系统操作由上下文控制
// 与进口商保持联系。导入模式必须为零，否则将被忽略。
// 不完全由纯Go文件组成的包可能无法导入，因为
// 类型检查器可能无法确定所有导出的实体（例如，由于cgo依赖关系）。
func (p *Importer) ImportFrom(path, srcDir string, mode types.ImportMode) (*types.Package, error) {
	if mode != 0 {
		panic("non-zero import mode")
	}

	if abs, err := p.absPath(srcDir); err == nil { // 见第14282期
		srcDir = abs
	}
	bp, err := p.ctxt.Import(path, srcDir, 0)
	if err != nil {
		return nil, err // 错误可能是*build.NoGoError-按原样返回
	}

	// 类型检查器知道包不安全
	if bp.ImportPath == "unsafe" {
		return types.Unsafe, nil
	}

	// 如果之前已完全导入包，则无需重新导入
	pkg := p.packages[bp.ImportPath]
	if pkg != nil {
		if pkg == &importing {
			return nil, fmt.Errorf("import cycle through package %q", bp.ImportPath)
		}
		if !pkg.Complete() {
			// 包存在但不完整-我们无法处理此问题
			// 在源导入程序替换软件包之后
			// 批发而不是扩大（详情见#19337）。
			// 返回包含错误的不完整包（请参见#16088）。
			return pkg, fmt.Errorf("reimported partially imported package %q", bp.ImportPath)
		}
		return pkg, nil
	}

	p.packages[bp.ImportPath] = &importing
	defer func() {
		// 如果出现错误，请进行清理
		// TODO（gri）最终我们可能想留下一个（可能是空的）
		// 在所有情况下都在映射中打包（并使用该包
		// 确定周期）。另见第16088期。
		if p.packages[bp.ImportPath] == &importing {
			p.packages[bp.ImportPath] = nil
		}
	}()

	var filenames []string
	filenames = append(filenames, bp.GoFiles...)
	filenames = append(filenames, bp.CgoFiles...)

	files, err := p.parseFiles(bp.Dir, filenames)
	if err != nil {
		return nil, err
	}

	// 类型检查包文件
	var firstHardErr error
	conf := types.Config{
		IgnoreFuncBodies: true,
		// 在出现第一个错误后继续类型检查
		Error: func(err error) {
			if firstHardErr == nil && !err.(types.Error).Soft {
				firstHardErr = err
			}
		},
		Importer: p,
		Sizes:    p.sizes,
	}
	if len(bp.CgoFiles) > 0 {
		if p.ctxt.OpenFile != nil {
			// cgo、gcc、pkg配置等不支持
			// build.Context的VFS。
			conf.FakeImportC = true
		} else {
			setUsesCgo(&conf)
			file, err := p.cgo(bp)
			if err != nil {
				return nil, err
			}
			files = append(files, file)
		}
	}

	pkg, err = conf.Check(bp.ImportPath, p.fset, files, nil)
	if err != nil {
		// 如果出现硬错误，则可能不安全
		// 使用包，因为它可能未完全填充。
		// 请勿退回（另请参见#20837，#20855）。
		if firstHardErr != nil {
			pkg = nil
			err = firstHardErr // 优先考虑第一个硬错误而不是任何软错误
		}
		return pkg, fmt.Errorf("type-checking package %q failed (%v)", bp.ImportPath, err)
	}
	if firstHardErr != nil {
		// 只有当go/types中存在bug时，才会发生这种情况
		panic("package is not safe yet no error was returned")
	}

	p.packages[bp.ImportPath] = pkg
	return pkg, nil
}

func (p *Importer) parseFiles(dir string, filenames []string) ([]*ast.File, error) {
	// 如果有，请使用build.Context的OpenFile
	open := p.ctxt.OpenFile
	if open == nil {
		open = func(name string) (io.ReadCloser, error) { return os.Open(name) }
	}

	files := make([]*ast.File, len(filenames))
	errors := make([]error, len(filenames))

	var wg sync.WaitGroup
	wg.Add(len(filenames))
	for i, filename := range filenames {
		go func(i int, filepath string) {
			defer wg.Done()
			src, err := open(filepath)
			if err != nil {
				errors[i] = err // open提供了错误的操作和文件名
				return
			}
			files[i], errors[i] = parser.ParseFile(p.fset, filepath, src, 0)
			src.Close() // 忽略关闭错误-解析可能已经成功，这就是我们所需要的
		}(i, p.joinPath(dir, filename))
	}
	wg.Wait()

	// 如果存在错误，则返回第一个错误以获得确定性结果
	for _, err := range errors {
		if err != nil {
			return nil, err
		}
	}

	return files, nil
}

func (p *Importer) cgo(bp *build.Package) (*ast.File, error) {
	tmpdir, err := os.MkdirTemp("", "srcimporter")
	if err != nil {
		return nil, err
	}
	defer os.RemoveAll(tmpdir)

	args := []string{"go", "tool", "cgo", "-objdir", tmpdir}
	if bp.Goroot {
		switch bp.ImportPath {
		case "runtime/cgo":
			args = append(args, "-import_runtime_cgo=false", "-import_syscall=false")
		case "runtime/race":
			args = append(args, "-import_syscall=false")
		}
	}
	args = append(args, "--")
	args = append(args, strings.Fields(os.Getenv("CGO_CPPFLAGS"))...)
	args = append(args, bp.CgoCPPFLAGS...)
	if len(bp.CgoPkgConfig) > 0 {
		cmd := exec.Command("pkg-config", append([]string{"--cflags"}, bp.CgoPkgConfig...)...)
		out, err := cmd.CombinedOutput()
		if err != nil {
			return nil, err
		}
		args = append(args, strings.Fields(string(out))...)
	}
	args = append(args, "-I", tmpdir)
	args = append(args, strings.Fields(os.Getenv("CGO_CFLAGS"))...)
	args = append(args, bp.CgoCFLAGS...)
	args = append(args, bp.CgoFiles...)

	cmd := exec.Command(args[0], args[1:]...)
	cmd.Dir = bp.Dir
	if err := cmd.Run(); err != nil {
		return nil, err
	}

	return parser.ParseFile(p.fset, filepath.Join(tmpdir, "_cgo_gotypes.go"), nil, 0)
}

// 上下文控制的文件系统操作

func (p *Importer) absPath(path string) (string, error) {
	// TODO（gri）这应该使用p.ctxt.AbsPath，而p.ctxt.AbsPath不会
	// 存在，但可能应该存在。另见第14282期。
	return filepath.Abs(path)
}

func (p *Importer) isAbsPath(path string) bool {
	if f := p.ctxt.IsAbsPath; f != nil {
		return f(path)
	}
	return filepath.IsAbs(path)
}

func (p *Importer) joinPath(elem ...string) string {
	if f := p.ctxt.JoinPath; f != nil {
		return f(elem...)
	}
	return filepath.Join(elem...)
}

// go:linkname setUsesCgo go/types.srcporter\u setUsesCgo
func setUsesCgo(conf *types.Config)
